Creating a Dev Container File for the Project. #10
Conversation
|
🎉 All Contributor License Agreements have been signed. Ready to merge. |
alpinegizmo
left a comment
alpinegizmo
left a comment
There was a problem hiding this comment.
I got a bit stuck until I figured out that I needed to install the dev containers extension for VS Code. Once I did that, it seemed to work -- but it's not immediately clear what this accomplished, or what the value is.
I'm also getting an error about the table planner being missing.
README.md
Outdated
|
|
||
| This repo contains a [.devcontainer.json](.devcontainer.json) file. | ||
|
|
||
| If you are using a Development Container compatible IDE (Eg. VS Code, IntelliJ Ultimate) and have Docker running, you can use the `.devcontainer.json` file to automatically configure your development environment with the required settings. |
There was a problem hiding this comment.
| If you are using a Development Container compatible IDE (Eg. VS Code, IntelliJ Ultimate) and have Docker running, you can use the `.devcontainer.json` file to automatically configure your development environment with the required settings. | |
| If you are using a Development Container compatible IDE (Eg. VS Code, IntelliJ Ultimate) and have Docker running, you can use the `.devcontainer.json` file to automatically configure your development environment with the required settings. This includes automatically setting up the correct version of the JVM, installing Maven, and potentially configuring your IDE with any required plugins. It will give you a fully functional development environment in moments. |
README.md
Outdated
|
|
||
| Depending on what IDE you are using, the process can vary. | ||
|
|
||
| In VS Code, open the folder that contains the `.devcontainer.json` file. When prompted, re-open it in the container. |
There was a problem hiding this comment.
| In VS Code, open the folder that contains the `.devcontainer.json` file. When prompted, re-open it in the container. | |
| In VS Code, open the folder that contains the `.devcontainer.json` file. When prompted, re-open it in the container. Please note that you may need to install the Dev Containers plugin for VS Code prior to opening. |
Added a bit more detail in the README to help clarify. However, to some extent, this is on the user. I provide the Dev Container as an option for them to use if they want to. They are not required to use it, and I'm not going to spend a bunch of time teaching it. It's sort of like including a Docker image. I wouldn't teach them about Docker. I'd expect them to already understand it.
No idea what is going on there. Have you tried a fresh checkout of the repo? I have done a fresh checkout and used my existing checkout. Both of them seem to work just fine. |
alpinegizmo
left a comment
alpinegizmo
left a comment
There was a problem hiding this comment.
Thanks for the additions to the README!
Description
Enter your description here.
Checklist
./build.sh validate.